Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: prioritize upgrade module in module manager #2987

Merged
merged 2 commits into from
Jan 2, 2025
Merged

Conversation

dreamer-zq
Copy link
Contributor

@dreamer-zq dreamer-zq commented Dec 31, 2024

Summary by CodeRabbit

  • Upgrades
    • Enhanced upgrade module processing priority.
    • Refined module initialization and block processing sequence.
    • Improved migration handling for module version transitions.

Copy link

coderabbitai bot commented Dec 31, 2024

Walkthrough

The pull request introduces modifications to the Iris application, focusing on the management of the upgrade module. Key changes include adding a new import for the upgradetypes package, restructuring module execution order in app/modules.go, and enhancing migration handling in app/rpc/auth.go. The IrisApp class is updated to prioritize the upgrade module during pre-block processing, ensuring a more controlled execution flow for application updates.

Changes

File Change Summary
app/app.go - Added import for upgradetypes
- Modified NewIrisApp to set upgrade module order using SetOrderPreBlockers()
- Added PreBlocker method for application updates before each block
app/modules.go - Removed upgradetypes.ModuleName from orderBeginBlockers
- Cleaned up commented import for ibcclientclient
app/keepers/keepers.go - Added import for ibcconnectiontypes
- Updated initParamsKeeper to register key tables for ibcconnectiontypes.Params, ibctransfertypes, and icahosttypes
app/rpc/auth.go - Added migration registration from version 4 to version 5 in overrideAuthServices with error handling

Possibly related PRs

  • feat: add v4 upgrade plan #2982: The changes in this PR involve adding a new version of the upgrade module, which is directly related to the modifications made in the main PR regarding the upgrade module's handling and processing order in the IrisApp.

Suggested reviewers

  • harvey-smith
  • mitch1024
  • wangjiulian

Poem

🐰 Upgrades dance in cosmic flow,
Modules shuffling to and fro,
A rabbit's code, precise and neat,
Rearranging blocks so sweet!
Cosmos spinning, order clear 🌟

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
app/modules.go (1)

51-51: Consider removing commented-out imports for cleanup.
The commented-out ibcclientclient import can be safely removed unless you plan to reintroduce it soon. Reducing commented-out code enhances readability.

-	//ibcclientclient "github.com/cosmos/ibc-go/v8/modules/core/02-client/client"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aabde0c and e515247.

📒 Files selected for processing (2)
  • app/app.go (2 hunks)
  • app/modules.go (1 hunks)
🔇 Additional comments (2)
app/app.go (2)

15-15: The new upgradetypes import is appropriate to support upgrade module priorities.
This is a valid import to ensure the upgrade module is acknowledged.


141-145: Ensuring the upgrade module is processed first is critical for stable upgrade flow.
By setting app.mm.SetOrderPreBlockers(upgradetypes.ModuleName), the upgrade module is now run before others during pre-block, preventing upgrade-related operations from being overshadowed or delayed. Verify that no other modules depend on pre-block execution prior to the upgrade module.

To confirm no inter-module dependencies are affected, please run integration testing on block upgrades, especially if other modules rely on a pre-block initialization step.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e515247 and b145a09.

📒 Files selected for processing (3)
  • app/app.go (4 hunks)
  • app/keepers/keepers.go (3 hunks)
  • app/rpc/auth.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/app.go
🔇 Additional comments (3)
app/keepers/keepers.go (3)

71-71: New IBC Connection import looks appropriate.

The addition of ibcconnectiontypes aligns with the use of ibcconnectiontypes.Params in the param key registration. Ensure that corresponding references and configurations for the IBC connection module are properly tested to confirm integration correctness.


617-620: Registering new param sets requires thorough testing.

You've introduced a new key table for IBC client parameters, including registration of &ibcconnectiontypes.Params{}. Confirm that this param set is exercised in tests and that any existing upgrade or migration scripts handle these newly registered parameters appropriately.


636-638: Ensure subspaces and key tables are synchronized across all IBC modules.

Registering subspaces for ibcexported.ModuleName, ibctransfertypes, and icahosttypes is consistent with the new IBC connection param updates. Double-check that all IBC modules dependent on these subspaces are properly linked, configured, and documented, especially if additional param sets or custom logic rely on them.

app/rpc/auth.go Show resolved Hide resolved
@mitch1024 mitch1024 merged commit fc5f567 into master Jan 2, 2025
4 checks passed
@mitch1024 mitch1024 deleted the fix/upgrade branch January 2, 2025 01:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants